home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / wb / czesc_3 / mungfriend / mungfriend3.1.doc < prev    next >
Text File  |  1997-01-24  |  5KB  |  230 lines
  1.                                 Mungfriend 3.1
  2.                             © 1995-97 Szymon Pura
  3.  
  4. ============
  5. INTRODUCTION
  6. ============
  7.  
  8.   MungFriend   is   a   tool   for  capturing  raw  serial  output  (done  via
  9.   exec/RawPutChar(),  kprintf).   It installs a resident (reset-proof) buffer,
  10.   so  it  can  survive  most  GURUs.   Especially  useful  for  debugging with
  11.   Mungwall, Enforcer etc.
  12.   Mungfriend is a replacement for Commodore's Sushi.
  13.  
  14. =====
  15. USAGE
  16. =====
  17.  
  18.   MungFriend <command> [<command args>] [options]
  19.  
  20.    <commands> are:          Shortcut:
  21.  
  22.   -  INFO                      I
  23.   -  INSTALL                   S
  24.   -  CLEAR                     C
  25.   -  REMOVE                    R
  26.   -  TYPE                      T
  27.   -  UPDATE                    U
  28.   -  WRITE                     W
  29.  
  30.   <command args> are:
  31.  
  32.   - SIZE <n>     where <n> is a decimal number (only for INSTALL)
  33.   - [TO] <f>       where <f> is a filename    (only for WRITE)
  34.  
  35.   <options> are:
  36.  
  37.   - FLASH / NOFLASH
  38.   - TRACE / NOTRACE
  39.   - SERIAL /  NOSERIAL
  40.   - BELLS / NOBELLS
  41.  
  42.  
  43.  (It seems complicated, but you'll be able to get hang of it in a second)
  44.  
  45.  
  46.  
  47. 1. CREATING MUNGFRIEND BUFFER
  48.  
  49.   MungFriend install size <n>  ; <n> - size of buffer (in bytes)
  50.  
  51.  Example:
  52.  
  53.   MungFriend install size 15000 ; allocate ~15 KB of a reset-proof buffer.
  54.  
  55.  Notes:
  56.  
  57.   You can't change size of buffer after installing - you must remove
  58.   previous buffer first.
  59.  
  60.   (New for V3.0): size must be >= 10KB.
  61.  
  62. 2. REMOVING MUNGFRIEND BUFFER
  63.  
  64.   MungFriend remove
  65.  
  66.  Removes the previously allocated buffer (see above).
  67.  
  68.  
  69.  
  70. 3. CLEARING BUFFER
  71.  
  72.   MungFriend clear
  73.  
  74.  Previous buffer contents are cleared.
  75.  
  76.  
  77.  
  78. 4. TYPE
  79.  
  80.   Mungfriend type
  81.  
  82.  Types contents of the current buffer on the screen.
  83.  
  84.  (New for V3.1): press CTRL-C to stop.
  85.  
  86.  
  87. 5. WRITE
  88.  
  89.   Mungfriend write [to] <f> ; <f> is a filename.
  90.  
  91.  Example:
  92.  
  93.   MungFriend write to Ram:MungFriendReport
  94.  
  95.  Creates a new file (called Ram:MungFriendReport) and copies current buffer
  96.  contents to it.
  97.  
  98.  
  99.  
  100. 6. UPDATE
  101.  
  102.   Mungfriend update <options>
  103.  
  104.  Examples:
  105.  
  106.   Mungfriend update FLASH TRACE NOSERIAL
  107.   Mungfriend update SERIAL NOTRACE BELLS FLASH
  108.  
  109.  Just updates the options specified.
  110.  
  111.  Note well:
  112.  
  113.   You can specify options with EVERY command, not only UPDATE.
  114.  
  115.  
  116.  
  117.  OPTIONS AVAILABLE:
  118.  
  119. 1. SERIAL/NOSERIAL
  120.  
  121.  If NOSERIAL is on, then all serial output (via exec/RawPutChar())
  122.  will be blocked.
  123.  
  124. 2. TRACE/NOTRACE
  125.  
  126.  Most important option. If TRACE is on, then MungFriend will catch serial
  127.  output into its buffer.
  128.  
  129.  NOTE WELL: THIS OPTION GETS DISABLED AFTER RESET !!
  130.  After every reset or GURU 'TRACE' gets disabled. To continoue tracing,
  131.  you have to turn it back on. Use something like: MungFriend update trace
  132.  
  133. 3. FLASH/NOFLASH
  134.  
  135.  If FLASH is on, then every byte going through the raw serial will cause
  136.  the screen to flash. This way you won't miss any debugging output.
  137.  
  138. 4. BELLS/NOBELLS
  139.  
  140.  If NOBELLS is on, then all console bells will be filtered out.
  141.  (Especially MungWall's report is full of those).
  142.  
  143. =======
  144. EXAMPLE
  145. =======
  146.  
  147.  Simple DOS script:
  148.  
  149.  MungFriend install size 15000 trace flash nobells noserial
  150.  Run Mungwall task all showfail nametag
  151.  Run Enforcer deadly showpc rawio buffersize 5000
  152.  
  153.  Every time the screen flashes use:
  154.  
  155.  MungFriend type
  156.  
  157.  
  158. =========
  159. TECHNICAL
  160. =========
  161.  
  162.  Kickstart V36+ (Release 2.0) required
  163.  
  164.  Assembler source included _ONLY_FOR_LEARNING_PURPOSES_
  165.  Source is meant to be an example (at least a bad one).
  166.  You are _NOT_ allowed to modify or re-assemble the source file.
  167.  
  168. =======
  169. CHANGES
  170. =======
  171.  
  172.  V3.1  -   20-Jan-97
  173.  --------------------
  174.  
  175.   o pressing CTRL-C during TYPE or WRITE will stop the command
  176.   o a tiny change in patch routine - should be slightly faster now
  177.   o added a trailing NULL to the ROMTag node structure
  178.   o now CPU caches are cleared during INSTALL
  179.  
  180.  V3.0  -  19-Nov-96
  181.  --------------------
  182.  
  183.   o totally redone memory allocation and KickMem/KickTag handling
  184.   o INFO improved
  185.   o some minor bugfixes and other minor changes
  186.  
  187.  V2.3  -  17-Nov-96
  188.  --------------------
  189.  
  190.   o major bug fixed in startup routine
  191.   o memory allocation seemed to be completely broken - changed to simple KickMem
  192.  
  193.  V2.2  -  26-Jun-96
  194.  --------------------
  195.  
  196.   o BELLS/NOBELLS option added
  197.  
  198.  V2.1  -  27-May-96
  199.  --------------------
  200.  
  201.   o LOADS of little bugs fixed
  202.  
  203.  V2.0  -  28-Feb-96
  204.  --------------------
  205.  
  206.   o now rewritten for OS 2.0+
  207.  
  208.  V1.0  -  19-Sep-95
  209.  --------------------
  210.  
  211.   o initial version
  212.  
  213.  
  214. ======
  215. AUTHOR
  216. ======
  217.  
  218.  MungFriend is FREEWARE. Use it at your own risk. It may be freely
  219.  distributed in its ORIGINAL, umodified form. Under NO CICRUMSTANCES
  220.  will the author be liable for any direct or indirect damage or data loss
  221.  resulting from the use or misuse of this software.
  222.  
  223.  All suggestions/bug reports/donations are welcome.
  224.  
  225.                                  Szymon Pura
  226.                                  Witosa 8/57
  227.                               42-224 Czestochowa
  228.                                     POLAND
  229.                                  +034 624666
  230.